/*
 * Copyright (C) 2010 Fores Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package jp.fores.midori.server.exception;


/**
 * midoriのサーバー側で発生する全ての例外クラスの親となる例外クラス。<br>
 */
public class MidoriServerException extends RuntimeException {
	//==========================================================
	//定数

	/**
	 * シリアルバージョンID
	 * (頻繁にシリアライズ・デシリアライズを行うクラスなので、少しでも処理が軽くなるようにするために定義しておく)
	 */
	private static final long serialVersionUID = 1L;

	/**
	 * エラーコードのデフォルト値
	 */
	public static final int DEFAULT_ERROR_CODE = 1;


	//==========================================================
	//フィールド

	/**
	 * エラーコード
	 */
	private int errorCode = DEFAULT_ERROR_CODE;


	//==========================================================
	//メソッド

	//_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/
	//コンストラクタ

	/**
	 * 詳細メッセージに null を使用して、新規例外を構築します。
	 */
	public MidoriServerException() {
		//親クラスのコンストラクタをそのまま呼び出す
		super();
	}

	/**
	 * 指定された詳細メッセージを使用して、新規例外を構築します。
	 *
	 * @param message 詳細メッセージ
	 */
	public MidoriServerException(String message) {
		//親クラスのコンストラクタをそのまま呼び出す
		super(message);
	}

	/**
	 * 指定された詳細メッセージおよび原因を使用して新規例外を構築します。
	 *
	 * @param message 詳細メッセージ
	 * @param cause 原因
	 */
	public MidoriServerException(String message, Throwable cause) {
		//親クラスのコンストラクタをそのまま呼び出す
		super(message, cause);
	}

	/**
	 * 指定された原因と詳細メッセージを持つ、新しい例外を構築します。
	 *
	 * @param cause 原因
	 */
	public MidoriServerException(Throwable cause) {
		//親クラスのコンストラクタをそのまま呼び出す
		super(cause);
	}


	//_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/
	//Getter, Setter

	/**
	 * エラーコードを取得します。
	 *
	 * @return エラーコード
	 */
	public int getErrorCode() {
		//フィールドの値をそのまま返す
		return this.errorCode;
	}

	/**
	 * エラーコードを設定します。
	 *
	 * @param errorCode エラーコード
	 */
	public void setErrorCode(int errorCode) {
		//引数の値をフィールドに設定
		this.errorCode = errorCode;
	}

}
